Get User ExtraField Option List

GET : http://<base_url>/digipay/v3/user/user_extra_field_options

This API is utilized to store get user extrafield options list with in the system.

QUERY PARAMS:-

Parameter	Type	Description	Value
extra_field_key	String	An additional key that might be used to represent supplementary information or metadata related to the data.	extra_key
is_active	Boolean	if value is true it will show active languages in response, if value is false it will show inActive langauages in response	true/false
skip	Int	Skip the first n document from the query result	1
limit	Int	Limits the number of records or documents that you want	1
start_date	Long	unix timestamp value in second	1
end_date	Long	unix timestamp value in second	1
sorting	Int	Sorting of the Data in the form of a string	123
search_keyword	String	a keyword which can be either name of language or a language code to get desired language as output	123

HEADERS:-

Parameter	Type	Description	Value
Authorization	String	It is a combination of type and token to authenticate user for the given token	Token duik7309njdlkhdauhknksadhjkas986876sd873j
CompanyID	String	Company_id is a unique primary id, that is represent company detail	76bc712200ca444fa334f9e55e5fd7a8

Request Body:-

Request Example

curl --request GET \
     --url 'http://192.168.1.102:8014/digipay/v3/user/user_extra_field_options?extra_field_key=extra_key&is_active=false&skip=1&limit=1&start_date=1&end_date=1&sorting=123&search_keyword=123' \
     --header 'Authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI2NWY0ZDI1MDliZmU0NTBmYTg4MTVhNTU5Njk3YmM0NyIsInJvbGVzIjpbIlJPTEVfQURNSU4iXSwiZXhwIjoxNjkzNTIxOTU1fQ.9oWwUzlFzmYB1ZOhaVamxKJH6DsMO8tFue2kbg2YyoI' \
     --header 'CompanyID: 76bc712200ca444fa334f9e55e5fd7a8' \
     --header 'accept: application/json'

Response:-

Response 200(OK)

{
  "success": 1,
  "error": [],
  "data": {
    "user_extra_field_option": [
      {
        "id": "2191e668d3794f50b8fe63c3a6556c55",
        "title": "number",
        "key": "number",
        "image": null,
        "depend": "N",
        "extra_field_key": "6e18d0cdb4f340cd8903bd6ff291f1c5",
        "parent_key": "6e18d0cdb4f340cd8903bd6ff291f1c5",
        "parent_value": "6e18d0cdb4f340cd8903bd6ff291f1c5"
      },
      {
        "id": "2191e668d3794f50b8fe63c3a6556c55",
        "title": "number",
        "key": "number",
        "image": null,
        "depend": "N",
        "extra_field_key": "6e18d0cdb4f340cd8903bd6ff291f1c5",
        "parent_key": "6e18d0cdb4f340cd8903bd6ff291f1c5",
        "parent_value": "6e18d0cdb4f340cd8903bd6ff291f1c5"
      }
    ]
  }

Response 400(BAD REQUEST)

{
    "success": 0,
    "error"": [1],
    "data": {
        "message": "BAD_REQUEST",
     }
}

RESPONSES :-

Status Code	Description
200	OK
400	BAD REQUEST
404	NOT FOUND
500	INTERNAL SERVER ERROR